/*
 * Copyright 2022 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.jmix.ldap.userdetails;

import java.util.Collection;

/**
 * Allows providing mapping between LDAP group name and Jmix role codes.
 */
public interface LdapAuthorityToJmixRoleCodesMapper {

    /**
     * Specifies which Jmix roles should be mapped to given LDAP {@code authority}.
     *
     * @param authority LDAP group name
     * @return collection of role codes in Jmix that should be matched to given {@code authority}
     */
    Collection<String> mapAuthorityToJmixRoleCodes(String authority);

}
